home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / tpapi.exe / DOCS / OLDDOCS.LZH / NWPRINT.DOC < prev    next >
Text File  |  1992-10-26  |  11KB  |  272 lines
  1.                                 PRINT SERVICES
  2.                                 ==============
  3.  
  4. --------------------------------------------------------------------------------
  5.  
  6.   CancelLPTCapture : WORD;
  7.  
  8.     Cancels a capture of default LPT device.
  9.  
  10. --------------------------------------------------------------------------------
  11.  
  12.   CancelSpecificLPTCapture (LPTDevice : BYTE) : WORD;
  13.  
  14.     Cancels the capture of a specified LPT device.
  15.  
  16.     LPTDevice (Input)                 : number of the LPT device.
  17.                                         00 = LPT1
  18.                                         01 = LPT2
  19.                                         02 = LPT3
  20.  
  21. --------------------------------------------------------------------------------
  22.  
  23.   EndLPTCapture : WORD;
  24.  
  25.     Ends the capture of the default LPT device.
  26.  
  27. --------------------------------------------------------------------------------
  28.  
  29.   EndSpecificLPTCapture (LPTDevice : BYTE) : WORD;
  30.  
  31.     Ends the capture of a specified LPT device.
  32.  
  33.     LPTDevice (Input)                 : number of the LPT device.
  34.                                         00 = LPT1
  35.                                         01 = LPT2
  36.                                         02 = LPT3
  37.  
  38. --------------------------------------------------------------------------------
  39.  
  40.   FlushLPTCapture : WORD;
  41.  
  42.     Closes the current capture of the default LPT device and starts another
  43.     capture.
  44.  
  45. --------------------------------------------------------------------------------
  46.  
  47.   FlushSpecificLPTCapture (LPTDevice : BYTE) : WORD;
  48.  
  49.     Closes the current capture of specified LPT device and starts another
  50.     capture.
  51.  
  52.     LPTDevice (Input)                 : number of the LPT device.
  53.                                         00 = LPT1
  54.                                         01 = LPT2
  55.                                         02 = LPT3
  56.  
  57. --------------------------------------------------------------------------------
  58.  
  59.   GetBannerUserName (VAR BannerUserName : BannerUserNameType) : WORD;
  60.  
  61.     Returns the user name that will be printed on a banner page.
  62.  
  63.     BannerUserName (Output)           : receives the user name.
  64.  
  65. --------------------------------------------------------------------------------
  66.  
  67.   GetDefaultCaptureFlags (VAR CaptureFlags : Capture_Flags) : WORD;
  68.  
  69.     Returns the print job flags for the default LPT device.
  70.  
  71.     CaptureFlags (Output)             : receives the capture flag settings.
  72.  
  73. --------------------------------------------------------------------------------
  74.  
  75.   GetDefaultLocalPrinter : WORD;
  76.  
  77.    Returns the number of the default LPT device to be used for capture calls.
  78.  
  79. --------------------------------------------------------------------------------
  80.  
  81.   GetLPTCaptureStatus (VAR LPTServerNumber : WORD) : WORD;
  82.  
  83.     Indicates whether the default capture is active.
  84.  
  85.     LPTServerNumber (Output)          : receives the current LPT server number.
  86.  
  87. --------------------------------------------------------------------------------
  88.  
  89.   GetPrinterQueue (PrinterNumber : BYTE; VAR QueueID : OT_BinderyID) : WORD;
  90.  
  91.     Returns the queue ID of the queue associated with specified printer number
  92.     on the file server.
  93.  
  94.     PrinterNumber (Input)             : number of the printer for which the
  95.                                         queueID will be returned.
  96.  
  97.     QueueID (Output)                  : the queueID of the printer.
  98.  
  99. --------------------------------------------------------------------------------
  100.  
  101.   GetPrinterStatus (PrinterNumber : BYTE; VAR PrinterHalted, PrinterOffLine,
  102.                     FormType, TargetPrinter : BYTE) : WORD;
  103.  
  104.     Returns the current status of a printer.
  105.  
  106.     PrinterNumber (Input)             : number of the printer for which the
  107.                                         status is to be returned.
  108.  
  109.     PrinterHalted (Output)            : 0 = printer is active.
  110.                                         255 = printer is inactive.
  111.  
  112.     PrinterOffline (Output)           : 1 = printer is offline.
  113.  
  114.     FormType (Output)                 : receives the current mounted form.
  115.  
  116.     TargetPrinter (Output)            : returns the number of the printer that
  117.                                         jobs are to be printed on.  Will be the
  118.                                         same as PrinterNumber unless server has
  119.                                         rerouted at the console.
  120.  
  121. --------------------------------------------------------------------------------
  122.  
  123.   GetSpecificCaptureFlags (LPTDevice : BYTE;
  124.                            VAR CaptureFlags : Capture_Flags) : WORD;
  125.  
  126.     Returns the capture flags for the specified LPT device.
  127.  
  128.     LPTDevice (Input)                 : number of the LPT device.
  129.                                         00 = LPT1
  130.                                         01 = LPT2
  131.                                         02 = LPT3
  132.  
  133.     CaptureFlags (Output)             : receives the capture flag settings for
  134.                                         the specified LPT device.
  135.  
  136. --------------------------------------------------------------------------------
  137.  
  138.   SetBannerUserName (BannerUserName : BannerUserNameType) : WORD;
  139.  
  140.     Sets the user name that is printed on a banner page.
  141.  
  142.     BannerUserName (Input)            : contains the banner user name.
  143.  
  144. --------------------------------------------------------------------------------
  145.  
  146.   SetCapturePrintJob (LPTDevice : BYTE; JobNumber : WORD;
  147.                       VAR JobFileHandle) :  WORD;
  148.  
  149.     JobFileHandle is file handle of a previously opened file.
  150.     Assigns a print job and NetWare file handle to the next capture of specified
  151.     LPT device.
  152.  
  153.     LPTDevice (Input)                 : number of the LPT device.
  154.                                         00 = LPT1
  155.                                         01 = LPT2
  156.                                         02 = LPT3
  157.  
  158.     JobNumber (Input)                 : the job number that QMS assigns to a
  159.                                         queue job entry in the queue.
  160.  
  161.     JobFileHandle (Input)             : file handle for the capture file
  162.                   (6 BYTES)             associated with the print queue job
  163.                                         entry.
  164.  
  165. --------------------------------------------------------------------------------
  166.  
  167.   SetCapturePrintQueue (LPTDevice : BYTE; ConnectionID : BYTE;
  168.                         QueueID : OT_BinderyID) : WORD;
  169.  
  170.     Sets the queuing server and the target print queue (queue ID) for the next
  171.     capture of the specified LPT device.
  172.  
  173.     LPTDevice (Input)                 : number of the LPT device.
  174.                                         00 = LPT1
  175.                                         01 = LPT2
  176.                                         02 = LPT3
  177.  
  178.     ConnectionID (Input)              : specifies the number of the server that
  179.                                         queues the print jobs.
  180.  
  181.     QueueID (Input)                   : contains the objectID of the print
  182.                                         queue where the jobs are to go.
  183.  
  184. --------------------------------------------------------------------------------
  185.  
  186.   SetDefaultCaptureFlags (CaptureFlags : Set_Capture_Flags) : WORD;
  187.  
  188.     Sets the capture flags for the default LPT device.
  189.  
  190.     CaptureFlags (Input)              : contains the new capture flag settings.
  191.  
  192. --------------------------------------------------------------------------------
  193.  
  194.   SetDefaultLocalPrinter (LPTDevice : BYTE) : WORD;
  195.  
  196.     Sets the default LPT device for capture files.
  197.  
  198.     LPTDevice (Input)                 : number of the LPT device.
  199.                                         00 = LPT1
  200.                                         01 = LPT2
  201.                                         02 = LPT3
  202.  
  203. --------------------------------------------------------------------------------
  204.  
  205.   SetSpecificCaptureFlags (LPTDevice : BYTE;
  206.                            CaptureFlags : Set_Capture_Flags) : WORD;
  207.  
  208.     Sets the capture flags for the specified LPT device.
  209.  
  210.     LPTDevice (Input)                 : number of the LPT device.
  211.                                         00 = LPT1
  212.                                         01 = LPT2
  213.                                         02 = LPT3
  214.  
  215.    CaptureFlags (Input)               : contains the new capture flag settings.
  216.  
  217. --------------------------------------------------------------------------------
  218.  
  219.   SetSpoolFlags (PrintFlags : BYTE; TabSize, PrinterNumber, NumberOfCopies,
  220.                  FormType : WORD; BannerUserName : BannerUserNameType) : WORD;
  221.  
  222.     Sets the spool flags at the file server that the print spooler will use when
  223.     printing a file.
  224.  
  225.     PrintFlags (Input)                : specifies one of the following
  226.                                         $20 = delete file after printing.
  227.                                         $40 = expand tabs to spaces.
  228.                                         $80 = print banner page.
  229.  
  230.    TabSize (Input)                    : column width to which tabs should be
  231.                                         expanded.
  232.  
  233.    PrinterNumber (Input)              : number of the printer to print to.
  234.  
  235.    NumberOfCopies (Input)             : number of copies to print.
  236.  
  237.    FormType (Input)                   : type of form which should be mounted.
  238.  
  239.    BannerUserName (Input)             : name that will appear on banner page.
  240.  
  241. --------------------------------------------------------------------------------
  242.  
  243.   SpecifyCaptureFile (DirectoryHandle : BYTE; FilePath : PathNameType) : WORD;
  244.  
  245.     Creates a spool capture file at the file specified by the user.
  246.  
  247.     DirectoryHandle (Input)           : points to an entry in the server's
  248.                                         Directory Handle Table. (ie A full
  249.                                         path)
  250.  
  251.     FilePath (Input)                  : an absolute path or a path relative to
  252.                                         the directory handle specified in
  253.                                         DriveHandle. Contains the filename.
  254.  
  255. --------------------------------------------------------------------------------
  256.  
  257.   StartLPTCapture : WORD;
  258.  
  259.     Starts the capture of the default LPT device.
  260.  
  261. --------------------------------------------------------------------------------
  262.  
  263.   StartsSpecificLPTCapture (LPTDevice : BYTE) : WORD;
  264.  
  265.     Starts the capture of a specific LPT device.
  266.  
  267.     LPTDevice (Input)                 : number of the LPT device.
  268.                                         00 = LPT1
  269.                                         01 = LPT2
  270.                                         02 = LPT3
  271. ------------------------------------------------------------------------------
  272.